package OddMuse;

=head1 NAME

000-wrapper.pl

=head1 DESCRIPTION

This module acts as a wrapper for OddMuse Namespaces.  Eventually, I'd like to
see all of OddMuse's functions exist in proper Namespaces.  (I think) it is a
lot easier to work with than one huge file, but until that happens (if ever),
this script will enable the use of NameSpaces as a sort of hack.

You should be aware that this package of modules implements a Database structure
of which parts are used to render pages.  This increases the complexity of an
OddMuse installation immensely.  At some point in the future, I plan on making
the use of a Database optional.

This package is an example of FeatureKarma.  But in my defense, I can't see
turning on a wiki without the features provided here.  OddMuse is a tight and
efficient piece of code, which is why I love working with it.  However, every
OddMuse site I know of makes use of at least some plugins.  This is my take on
what OddMuse *should* include by default.

My goal is to eventually replace all the modules I use, and integrate them into
this package.  On downloading this package, a user will have all the
functionality they could ever want - by simply enabling a few configuration
option.

Many of the modules included here have counterparts as plugins in OddMuse
proper.  For example, if all you want is an indexed search, you might look at
the search-freetext plugin.  If all you want is inline backlinks, there is a
plugin for that.  I try and keep any modules I make here mostly compatable with
their counterparts in the OddMuse CVS Repository.  And as I run across bugs in
existing plugins, I try and fix them and commit those changes back to the OddMuse
CVS Repo.

=head1 DEPENDENCIES

You'll need all of these modules in order to get this, or other modules in the
namespace working.  Grab these from CPAN.

L<Time::Format>, L<Date::Manip>, L<Exporter>, L<MLDBM>, L<DB_File>

I hope to eventually remove the need for Date::Manip, and Time::Format.  DB_File
is a part of *most* perl distributions, so you should have it allready.  MLDBM is
easy to install, as is Exporter.

=head1 SYNOPSIS

To use these modules, this file should be placed in your OddMuse modules
directory.  

Then put OddMuse.pm in your DataDir, as well as the directory OddMuse (which
contains most of the rest of these modules.

=cut

$VERSION   = ( q$Revision: 38 $ ) =~ /(\d+)/g;
$ModulesDescription .= '<p>OddMuse NameSpace wrapper version $VERSION</p>';
    
use lib "$DataDir"; # Add the DataDir to the Perl Lib Path
use OddMuse;        # Now Begin loading.

1;

__END__

=head1 BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to C<cmauch@gmail.com>

=head1 AUTHOR

Charles Mauch <cmauch@gmail.com>

=head1 LICENSE

Copyright (c) 2006 Charles Mauch

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA  02110-1301, USA.

=head1 SEE ALSO

perl(1).

=cut

# $Id: 001-wrapper.pl 38 2006-10-01 04:06:35Z cmauch $
